Overview
The Profit Power API Data Dictionary is a set of information describing the contents, format, and structure of the Profit Power API elements.
Not all elements are accessed from all enpoints. Some elements are exclusive to certain enpoints.
Allocations
| Title | Description | Type | Length | Format | Range | Required? | Unique? | Accept Null |
|---|---|---|---|---|---|---|---|---|
| Amount | Flat amount of the agents commission they are allocated. Amount OR Rate is required. | Decimal | 10 | 1865.76 | 0-9999999 | N | N | Y |
| AllocationGUID | The unique ID generated by Profit Power for this record. ONLY accessed on GETs | GUID | 36 | n/a | n/a | n/a | N | n/a |
| AllocationThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. | String | 8 | n/a | n/a | Y | Y | N |
| AllocatedToAssociateThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. | String | 255 | n/a | 0-39820 | Y | Y | N |
| CreatedBy | The person that created the record. ONLY accessed on GETs | String | n/a | n/a | n/a | n/a | n/a | n/a |
| DateEntered | The date the record was created in Profit Power. JSON dates have the same format as the ISO-8601 standard ONLY accessed on GETs |
DateTime | 24 | YYYY-MM-DDTHH:mm:ss.sssZ | n/a | n/a | n/a | n/a |
| DateUpdated | The date the record was updated in Profit Power. JSON dates have the same format as the ISO-8601 standard ONLY accessed on GETs |
DateTime | 24 | YYYY-MM-DDTHH:mm:ss.sssZ | n/a | n/a | n/a | n/a |
| Rate | Percentage of the agents commission they are allocated. Amount OR Rate is required. | Decimal | 3 | .5 | .01-1 | N | N | Y |
AR Import
| Title | Description | Type | Length | Format | Range | Required? | Unique? | Accept Null |
|---|---|---|---|---|---|---|---|---|
| ActualCost | The actual amount the company paid. | Decimal | 10 | 15423.76 | 0-9999999 | N | N | Y |
| AssociateID | Profit Power record ID for the associate. Either the AssociateID or AssociateThirdPartyID is required. | String | 8 | n/a | n/a | Y | Y | N |
| AssociateThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. Either the AssociateID or AssociateThirdPartyID is required | String | 255 | n/a | 0-39820 | Y | Y | N |
| ARDetailThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. | String | 255 | ARD-7777 | n/a | Y | Y | N |
| ARImportBatchGUID | The unique ID generated by Profit Power for this record. ONLY accessed on GETs | GUID | 36 | n/a | n/a | n/a | N | n/a |
| ARImportDetailGUID | The unique ID generated by Profit Power for this record. ONLY accessed on GETs | GUID | 36 | n/a | n/a | n/a | N | n/a |
| ARImportHeaderGUID | The unique ID generated by Profit Power for this record. ONLY accessed on GETs | GUID | 36 | n/a | n/a | n/a | N | n/a |
| BatchThirdPartyID | This is the ID representing the entire batch being processed | String | 200 | n/a | n/a | Y | Y | N |
| Charge | This is the dollar amount the agent is being charged | Decimal | 10 | 15423.76 | 0-9999999 | Y | n/a | N |
| Comment | Free form area for comments | String | 50 | n/a | n/a | N | N | Y |
| Comment2 | Free form area for additional comments. Read only in Profit Power. Only used for reporting. | String | 200 | n/a | n/a | N | N | Y |
| CompanyNo | The Profit Power simplified and friendly ID. | String | 3 | Pay 35% referral to Broker Realty Services | n/a | N | N | Y |
| CompanyThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. This OR CompanyNo is required. | String | 200 | n/a | n/a | N | N | Y |
| Description | Information that identifies what the cost if for. | String | 50 | MLS Fees | n/a | Y | N | N |
| DueDate | The date the charge is due. JSON dates have the same format as the ISO-8601 standard |
DateTime | 24 | YYYY-MM-DDTHH:mm:ss.sssZ | n/a | Y | n/a | N |
| HeaderThirdPartyID | ID representing a specific group of records in the batch | String | 200 | n/a | n/a | N | N | Y |
| isPosted | Flag to identigy if the record has been posted in Profit Power. ONLY accessed on GETs | Boolean | 5 | True | True or False | n/a | n/a | n/a |
| PostDate | The journaization date for this AR header. JSON dates have the same format as the ISO-8601 standard. No time specified for this date. ONLY accessed on GETs |
DateTime | 24 | YYYY-MM-DD | n/a | n/a | n/a | n/a |
| SortCode | Category of charges used to determain the GL accounts. | String | 30 | Marketing | n/a | Y | N | N |
| Reference | Counld be an invoice or reference number. | String | 255 | R2343 | n/a | N | N | Y |
Associate
| Title | Description | Type | Length | Format | Range | Required? | Unique? | Accept Null |
|---|---|---|---|---|---|---|---|---|
| ActiveFlag | The active flag of the Associate. | Integer | 0 or 1 | 1 | n/a | Y | N | N |
| Address | The street address of the Associate. | String | 30 | 123 Main St | n/a | N | N | Y |
| AssociateMLSIDs | MLS IDs this agent is associated with. Refer to Associate MLS IDs definition on this page. |
Object | n/a | n/a | n/a | n/a | n/a | n/a |
| AssistantName | Name of the assistant | String | 2000 | Jane Smith | n/a | N | N | Y |
| AssociateGUID | The unique ID generated by Profit Power for this record. ONLY accessed on GETs | GUID | 36 | n/a | n/a | n/a | n/a | n/a |
| AssociateNo | The Profit Power simplified and friendly ID for displaying on the UI. ONLY accessed on GETs | String | 8 | n/a | n/a | n/a | n/a | n/a |
| AssociateThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. | String | 255 | n/a | 0-39820 | Y | Y | N |
| BirthDate | The birth date of the Associate. | Date | 10 | YYYY-MM-DD | n/a | N | N | Y |
| Cellular | Cell phone number | String | 15 | 111-111-1111 | n/a | N | N | Y |
| CellularPublish | The flag identifying this number as being published. | Integer | 0 or 1 | 1 | n/a | Y | N | N |
| City | The city of the Associate address. | String | 20 | Buffalo | n/a | N | N | Y |
| CommissionAnniversaryDate | The commission anniversary date of the Associate. | Date | 10 | YYYY-MM-DD | n/a | N | N | Y |
| CompanyGUID | The unique ID generated by Profit Power for this record. ONLY accessed on GETs | GUID | 36 | n/a | n/a | n/a | n/a | n/a |
| CompanyNo | The Profit Power simplified and friendly ID for displaying on the UI. ONLY accessed on GETs | String | 3 | n/a | n/a | n/a | n/a | n/a |
| CompanyThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. | String | 255 | n/a | n/a | Y | N | N |
| CorporateID | Corporate ID from HR systems, etc. | String | 15 | CID-12345 | n/a | N | N | Y |
| CreatedBy | The account that created the record in Profit Power. ONLY accessed on GETs | String | 50 | n/a | n/a | n/a | n/a | n/a |
| CrestOfficeGUID | Realogy Franchise Office ID | GUID | 36 | n/a | n/a | N | N | Y |
| CrestPersonGUID | Realogy Franchise Person ID | GUID | 36 | n/a | n/a | N | N | Y |
| CrestSAGUID | Realogy Franchise Sales associate ID. Only populated if they are an agent. | GUID | 36 | n/a | n/a | N | N | Y |
| DateEntered | The date the record was create in Profit Power. JSON dates have the same format as the ISO-8601 standard ONLY accessed on GETs |
DateTime | 24 | YYYY-MM-DDTHH:mm:ss.sssZ | n/a | n/a | n/a | n/a |
| DateUpdated | The date the record was updated in Profit Power. JSON dates have the same format as the ISO-8601 standard ONLY accessed on GETs |
DateTime | 24 | YYYY-MM-DDTHH:mm:ss.sssZ | n/a | n/a | n/a | n/a |
| Designations | Professional Designations | String | 20 | CRB, CCIM | n/a | N | N | Y |
| DirectBusLine | Direct busisness phone number. | String | 15 | 111-111-1111 | n/a | N | N | Y |
| DirectBusLineExt | Direct busisness phone number extension. | String | 5 | 123 | n/a | N | N | Y |
| EmailAddress | Although not an ID this must be unique for every associate in the system because it is used to connect referencial data from records back to the Associate when needed. | String | 50 | [email protected] | n/a | Y | Y | N |
| Fax | Fax number. | String | 15 | 111-111-1111 | n/a | N | N | Y |
| FirstName | The first name of the Associate. | String | 15 | James | n/a | Y | N | N |
| Gender | The gender of the Associate. | String | 10 | Male or Female | n/a | N | N | Y |
| HireDate | The hire date of the Associate. | Date | 10 | YYYY-MM-DD | n/a | N | N | Y |
| InsuranceNote | Notes entered for the insurance. | String | 4000 | This is a note | n/a | N | N | Y |
| LastName | The last name of the Associate. | String | 25 | Smith | n/a | Y | N | N |
| Languages | Spoken languages by this assocaite. | String | 50 | English, Spanish | n/a | N | N | Y |
| LicenseIssuedDate | The license number issue date of the Associate. | Date | 10 | YYYY-MM-DD | n/a | N | N | Y |
| LicenseNumber | The license number of the Associate. | String | 25 | 0225 217541 | n/a | N | N | Y |
| LicenseRenewDate | The license number renew date of the Associate. | Date | 10 | YYYY-MM-DD | n/a | N | N | Y |
| MiddleInitial | The middle initial of the Associate. | String | 1 | E | n/a | N | N | Y |
| MLSCode | The MLS code of the Associate. | String | 100 | 3034038 | n/a | N | N | Y |
| OfficeGUID | The unique ID generated by Profit Power for this record. ONLY accessed on GETs | GUID | 36 | n/a | n/a | n/a | n/a | n/a |
| OfficeNo | The Profit Power simplified and friendly ID for displaying on the UI. ONLY accessed on GETs | String | 3 | n/a | n/a | n/a | n/a | n/a |
| OfficeThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. | String | 255 | n/a | n/a | Y | N | N |
| Other | Agent nickname | String | 15 | Bobby | n/a | n/a | n/a | n/a |
| Pager | Pager number. | String | 15 | 111-111-1111 | n/a | N | N | Y |
| PagerPublish | The flag identifying this number as being published. | Integer | 0 or 1 | 1 | n/a | Y | N | N |
| Paging | Refer to Paging definition on this page. ONLY accessed on GETs | Object | n/a | n/a | n/a | n/a | n/a | n/a |
| PersonalEmail | Personal email of the associate. | String | 120 | [email protected] | n/a | Y | Y | N |
| RelocationRating | Relocation rating used in reporting | String | 50 | n/a | n/a | Y | Y | N |
| ResidentialFax | Residential fax number. | String | 15 | 111-111-1111 | n/a | N | N | Y |
| ResidentialFaxPublish | The flag identifying this number as being published. | Integer | 0 or 1 | 1 | n/a | Y | N | N |
| ResidentialPhone | Residential phone number. | String | 15 | 111-111-1111 | n/a | N | N | Y |
| ResidentialPhonePublish | The flag identifying this number as being published. | Integer | 0 or 1 | 1 | n/a | Y | N | N |
| Salutation | The salutation of the Associate. | String | 15 | Mr. | n/a | N | N | Y |
| State | The state of the Associate address. | String | 10 | NY | n/a | N | N | Y |
| TaxID | The tax id of the Associate. | String | 9 | 125697865 | n/a | N | N | Y |
| DateTerminated | The termination date of the Associate. | Date | 10 | YYYY-MM-DD | n/a | N | N | Y |
| Title | The title of the Associate. | String | 150 | Associate | n/a | N | N | Y |
| UnitNumber | The unit number on address of the Associate. | String | 30 | Apt 3B | n/a | N | N | Y |
| UpdatedBy | The account that updated the record in Profit Power. ONLY accessed on GETs | String | 40 | n/a | n/a | n/a | n/a | n/a |
| Zip | The zip of the Associate address. | String | 9 | 14224 | n/a | N | N | Y |
Associate MLS IDs
This is a subset of the Associate Object. There can be many AssociateMLSIDs to each Assocaite.
| Title | Description | Type | Length | Format | Range | Required? | Unique? | Accept Null |
|---|---|---|---|---|---|---|---|---|
| MLSBoardID | The MLS Board of the Associate's MLS ID. | String | 100 | 123456-BB | n/a | Y | N | N |
| MLSID | The MLS ID of the Associate for this MLS Board. | String | 50 | A034038 | n/a | Y | N | N |
| PrimaryFlag | The primary flag of the MLS. This identifies which MLS ID is the primary one for the Associate. | Integer | 0 or 1 | 1 | n/a | Y | N | N |
Branch Office
| Title | Description | Type | Length | Format | Range | Required? | Unique? | Accept Null |
|---|---|---|---|---|---|---|---|---|
| ActiveFlag | The active flag of the Office. | Integer | 0 or 1 | 1 | n/a | Y | N | N |
| Address | The street address of the Office. | String | 40 | 123 Main St | n/a | N | N | Y |
| City | The city of the Office address. | String | 25 | Buffalo | n/a | N | N | Y |
| CompanyThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. | String | 255 | n/a | n/a | Y | N | N |
| CompanyGUID | The unique ID generated by Profit Power for this record. ONLY accessed on GETs | GUID | 36 | n/a | n/a | n/a | n/a | n/a |
| CompanyName | The company name. ONLY accessed on GETs | String | 50 | Real Estate Company Inc | n/a | n/a | n/a | n/a |
| CompanyNo | The Profit Power simplified and friendly ID for displaying on the UI. ONLY accessed on GETs | String | 3 | n/a | n/a | n/a | n/a | n/a |
| Country | Default is 'U.S.A.' | String | 15 | U.S.A. | n/a | N | N | Y |
| CreatedBy | The account that created the record in Profit Power. ONLY accessed on GETs | String | 50 | n/a | n/a | n/a | n/a | n/a |
| CrestOfficeGUID | Realogy Franchise Office ID | GUID | 36 | n/a | n/a | N | N | Y |
| DateEntered | The date the record was create in Profit Power. JSON dates have the same format as the ISO-8601 standard. ONLY accessed on GETs |
DateTime | 24 | YYYY-MM-DDTHH:mm:ss.sssZ | n/a | n/a | n/a | n/a |
| DateUpdated | The date the record was updated in Profit Power. JSON dates have the same format as the ISO-8601 standard. ONLY accessed on GETs |
DateTime | 24 | YYYY-MM-DDTHH:mm:ss.sssZ | n/a | n/a | n/a | n/a |
| EmailAddress | Email address associated with the branch office. | String | 100 | [email protected] | n/a | N | N | Y |
| Fax | The fax of the Office. | String | 12 | 111-111-1111 | n/a | N | N | Y |
| GeoCode | This is usually the geographic region code (not all companies use this). ONLY accessed on GETs | String | 3 | 001 | n/a | n/a | n/a | n/a |
| GeoCodeName | This is usually the geographic region name (not all companies use this). ONLY accessed on GETs | String | 50 | Western | n/a | n/a | n/a | n/a |
| OfficeGUID | The unique ID generated by Profit Power for this record. ONLY accessed on GETs | GUID | 36 | n/a | n/a | n/a | n/a | n/a |
| OfficeName | The name of the Office | String | 50 | Office 101 | n/a | Y | Y | N |
| OfficeNo | The Profit Power simplified and friendly ID for displaying on the UI. ONLY accessed on GETs | String | 3 | n/a | n/a | n/a | n/a | n/a |
| OfficeThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. | String | 255 | n/a | n/a | Y | Y | N |
| Paging | Refer to Paging definition on this page. ONLY accessed on GETs | Object | n/a | n/a | n/a | n/a | n/a | n/a |
| Phone | The phone of the Office. | String | 12 | 111-111-1111 | n/a | N | N | Y |
| State | The state of the Office address. | String | 2 | NY | n/a | N | N | Y |
| UnitNumber | The unit number on address of the Office. | String | 40 | Apt 3B | n/a | N | N | Y |
| Zip | The zip of the Office address. | String | 12 | 14224 | n/a | N | N | Y |
Client
The listing object can have two clients on it represented as Seller1Client and Seller2Client.
The sale object can have two clients on it represented as Buyer1Client and Buyer2Client.
| Title | Description | Type | Length | Format | Range | Required? | Unique? | Accept Null |
|---|---|---|---|---|---|---|---|---|
| AppartmentNumber | The unit number of the address. | String | 100 | Apt 3B | n/a | N | N | Y |
| Cell | The cell phone. | String | 12 | 111-111-1111 | n/a | N | N | Y |
| ClientGUID | The unique ID generated by Profit Power for this record. ONLY accessed on GETs | GUID | 36 | n/a | n/a | n/a | n/a | n/a |
| ClientNo | The Profit Power simplified and friendly ID for displaying on the UI. ONLY accessed on GETs | String | 8 | n/a | n/a | n/a | n/a | n/a |
| ClientThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. | String | 255 | n/a | n/a | Y | Y | N |
| ClientType | The type of client this is (buyer, seller are the most common) | String | 15 | Buyer | n/a | Y | N | N |
| City | The city of the address. | String | 100 | Buffalo | n/a | N | N | Y |
| CreatedBy | The account that created the record in Profit Power. ONLY accessed on GETs | String | 50 | n/a | n/a | n/a | n/a | n/a |
| DateEntered | The date the record was create in Profit Power. JSON dates have the same format as the ISO-8601 standard ONLY accessed on GETs |
DateTime | 24 | YYYY-MM-DDTHH:mm:ss.sssZ | n/a | n/a | n/a | n/a |
| DateUpdated | The date the record was updated in Profit Power. JSON dates have the same format as the ISO-8601 standard ONLY accessed on GETs |
DateTime | 24 | YYYY-MM-DDTHH:mm:ss.sssZ | n/a | n/a | n/a | n/a |
| The email. | String | 100 | [email protected] | n/a | N | N | Y | |
| FirstName | The first name. | String | 100 | James | n/a | N | N | N |
| FirstName2 | The secondary first name. | String | 100 | Laura | n/a | N | N | N |
| LastName | The last name. | String | 100 | Smith | n/a | Y | N | N |
| LastName2 | The secondary last name. | String | 100 | Smith | n/a | N | N | N |
| Phone | The phone. | String | 12 | 111-111-1111 | n/a | N | N | Y |
| StreetNumber | The street number of the address. | String | 100 | 123 | n/a | N | N | Y |
| StreetName | The street name of the address. | String | 100 | Main St | n/a | N | N | Y |
| State | The state of the address. | String | 16 | NY | n/a | N | N | Y |
| UpdatedBy | The account that updated the record in Profit Power. ONLY accessed on GETs | String | 40 | n/a | n/a | n/a | n/a | n/a |
| Zip | The zip of the address. | String | 11 | 14224 | n/a | N | N | Y |
Client Marketing
Client marketing data for a sale.
This endpoint is for GETs only.
| Title | Description | Type | Length | Format | Range | Required? | Unique? | Accept Null | AgentEmailAddress | The email. | String | 100 | [email protected] | n/a | n/a | n/a | n/a |
|---|---|---|---|---|---|---|---|---|
| AgentFirstName | The first name of the Associate. | String | 15 | James | n/a | n/a | n/a | n/a |
| AgentLastName | The last name of the Associate. | String | 15 | Smith | n/a | n/a | n/a | n/a |
| AgentID | The Profit Power simplified and friendly ID for displaying on the UI. ONLY accessed on GETs | String | 8 | n/a | n/a | n/a | n/a | n/a |
| ClientEmail | The email. | String | 100 | [email protected] | n/a | n/a | n/a | n/a |
| ClientFirstName | The first name. | String | 100 | James | n/a | n/a | n/a | n/a |
| ClientLastName | The last name. | String | 100 | Smith | n/a | n/a | n/a | n/a |
| ClientID | The Profit Power simplified and friendly ID for displaying on the UI. ONLY accessed on GETs | String | 8 | n/a | n/a | n/a | n/a | n/a |
| ClientType | The type of client this is (buyer, seller are the most common) | String | 15 | Buyer | n/a | n/a | n/a | n/a |
| CompanyAddress1 | The address. | String | 40 | 123 Main St | n/a | n/a | n/a | n/a |
| CompanyAddress2 | The address. | String | 40 | Apt 3B | n/a | n/a | n/a | n/a |
| CompanyCity | The city of the address. | String | 100 | Buffalo | n/a | n/a | n/a | n/a |
| CompanyName | The company being represented. | String | 100 | Our Company | n/a | n/a | n/a | n/a |
| CompanyState | The state of the address. | String | 16 | NY | n/a | n/a | n/a | n/a |
| CompanyZip | The zip of the address. | String | 11 | 14224 | n/a | n/a | n/a | n/a |
| DateEntered | Date entered into Profit Power. | Date | 10 | YYYY-MM-DD | n/a | n/a | n/a | n/a |
| EstimatedCloseDate | The estimated closing date. | Date | 10 | YYYY-MM-DD | n/a | n/a | n/a | n/a |
| FinalClosingDate | The final closing date. | Date | 10 | YYYY-MM-DD | n/a | n/a | n/a | n/a |
| Paging | Refer to Paging definition on this page. ONLY accessed on GETs | Object | n/a | n/a | n/a | n/a | n/a | n/a |
| PropertyAddress | The street number of the address. | String | 100 | 123 Main St | n/a | n/a | n/a | n/a |
| PropertyCity | The street name of the address. | String | 100 | Buffalo | n/a | n/a | n/a | n/a |
| PropertyState | The state of the address. | String | 16 | NY | n/a | n/a | n/a | n/a |
| PropertyZipCode | The zip of the address. | String | 11 | 14224 | n/a | n/a | n/a | n/a |
| SaleNumber | The Profit Power simplified and friendly ID for displaying on the UI. ONLY accessed on GETs | String | 8 | n/a | n/a | n/a | n/a | n/a |
Closing Payments
| Title | Description | Type | Length | Format | Range | Required? | Unique? | Accept Null |
|---|---|---|---|---|---|---|---|---|
| ClosingPaymentsDetailGUID | The unique ID generated by Profit Power for this record. ONLY accessed on GETs | GUID | 36 | n/a | n/a | n/a | N | n/a |
| BankAccountNumber | The account number for the bank being used. | String | 20 | n/a | n/a | Y | N | N |
| BatchThirdPartyID | This is the ID representing the entire batch being processed | String | 255 | n/a | n/a | Y | Y | N |
| CheckNumber | Number representing the check being processed. | String | 50 | n/a | n/a | N | N | Y |
| CheckType | The type of check being submitted. | String | 50 | n/a | n/a | N | N | Y |
| ClosingPaymentsBatchGUID | The unique ID generated by Profit Power for this record. ONLY accessed on GETs | GUID | 36 | n/a | n/a | n/a | N | n/a |
| DepositDate | Date this was deposited. | DateTime | 24 | YYYY-MM-DDTHH:mm:ss.sssZ | n/a | n/a | n/a | n/a |
| DepositNumber | Number representing this deposit record. This is usually the number the bank sends representing this deposit. | String | 15 | n/a | n/a | N | N | Y |
| DetailThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. | String | 255 | n/a | n/a | Y | Y | N |
| DateEntered | Date record was entered into Profit Power. ONLY accessed on GETs | DateTime | 24 | YYYY-MM-DDTHH:mm:ss.sssZ | n/a | n/a | n/a | n/a |
| NameOnDeposit | The name of the entity giving the money. | String | 40 | n/a | n/a | N | N | Y |
| PaymentAmount | The amount entering for this record | Decimal | 10 | 5274.66 | .01-9999999 | Y | N | N |
| TotalPaymentAmount | Should equal the sum of all the payment amounts in the batch. | Decimal | 10 | 5274.66 | .01-9999999 | Y | N | N |
Commission
The commission is an element on the sale object. Each agent on a deal side needs to have a commission. This can be a single commission record or an array.
| Title | Description | Type | Length | Format | Range | Required? | Unique? | Accept Null |
|---|---|---|---|---|---|---|---|---|
| Allocations | Portion of an agents commission given to a differernt agent. Refer to Allocations definition on this page. |
Object | n/a | n/a | n/a | n/a | n/a | n/a |
| AssociateSplit | This is the percentage of the commission for this record. | Decimal | 5 | 0.50 | .01-1.0 | Y | N | N |
| AssociateThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. | String | 255 | n/a | n/a | Y | N | N |
| CommissionComments | Any comments associated to the commission record. | String | 75 | This is a comment | n/a | N | N | N |
| CommissionGUID | The unique ID generated by Profit Power for this record. ONLY accessed on GETs | GUID | 36 | n/a | n/a | n/a | n/a | n/a |
| CommissionNo | The Profit Power simplified and friendly ID for displaying on the UI. ONLY accessed on GETs | String | 8 | n/a | n/a | n/a | n/a | n/a |
| CommissionRole | Payplan the client wants to use. Defaults to “Standard” | String | 30 | Standard | n/a | N | N | Y |
| CommissionThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. | String | 255 | n/a | n/a | N | N | Y |
| CreatedBy | The account that created the record in Profit Power. ONLY accessed on GETs | String | 50 | n/a | n/a | n/a | n/a | n/a |
| DateEntered | The date the record was create in Profit Power. JSON dates have the same format as the ISO-8601 standard. ONLY accessed on GETs |
DateTime | 24 | YYYY-MM-DDTHH:mm:ss.sssZ | n/a | n/a | n/a | n/a |
| DateUpdated | The date the record was updated in Profit Power. JSON dates have the same format as the ISO-8601 standard. ONLY accessed on GETs |
DateTime | 24 | YYYY-MM-DDTHH:mm:ss.sssZ | n/a | n/a | n/a | n/a |
| MarketingFeeAmount | This is the dollar amount for the marketing fee (agent off the top fee) | Decimal | 10 | 15423.76 | 0-9999999 | N | N | Y |
| MarketingFeeRate | This is the percentage of the marketing fee (agent off the top fee) | Decimal | 6 | 0.025 | 0-1 | N | N | Y |
| RolePlayed | Side of the deal this commission record represents | String | 20 | Listing | n/a | Y | N | N |
| OfficeGUID | The unique ID generated by Profit Power for this record. ONLY accessed on GETs | GUID | 36 | n/a | n/a | n/a | n/a | n/a |
| OfficeThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. POSTs and PUTs this represents the Override Office used to this transaction. If this is left blank Profit Power will use the associates primary office. | String | 255 | n/a | n/a | N | N | Y |
| OverrideMarketingFee | The flag that identifies the system use the MarketingFeeRate or MarketingFeeAmount passed to Profit Power. | Integer | 0 or 1 | 1 | n/a | Y | N | N |
Errors (comming soon)
| Title | Description | Type | Length | Format | Range | Required? | Unique? | Accept Null |
|---|
Escrow (comming soon)
| Title | Description | Type | Length | Format | Range | Required? | Unique? | Accept Null |
|---|
Listing
| Title | Description | Type | Length | Format | Range | Required? | Unique? | Accept Null |
|---|---|---|---|---|---|---|---|---|
| City | The city of the address. | String | 100 | Buffalo | n/a | N | N | Y |
| County | The county of the address. | String | 100 | Erie | n/a | N | N | Y |
| CreatedBy | The account that created the record in Profit Power. ONLY accessed on GETs | String | 50 | n/a | n/a | n/a | n/a | n/a |
| CurrentPrice | The price the listing is currently | Decimal | 15 | 1418999.90 | n/a | N | N | Y |
| DateEntered | The date the record was create in Profit Power. JSON dates have the same format as the ISO-8601 standard ONLY accessed on GETs |
DateTime | 24 | YYYY-MM-DDTHH:mm:ss.sssZ | n/a | n/a | n/a | n/a |
| DateUpdated | The date the record was updated in Profit Power. JSON dates have the same format as the ISO-8601 standard ONLY accessed on GETs |
DateTime | 24 | YYYY-MM-DDTHH:mm:ss.sssZ | n/a | n/a | n/a | n/a |
| ExpirationDate | The date this expires. | Date | 10 | YYYY-MM-DD | n/a | Y | N | N |
| HalfBaths | The total half baths on the listing | Integer | 2 | n/a | 0-99 | N | N | Y |
| HomeWarranty | The flag identifying there is a home warrenty on this listing. | Integer | 0 or 1 | 1 | n/a | N | N | Y |
| InitialPrice | The price the listing inistially started at | Decimal | 15 | 1498999.90 | n/a | N | N | Y |
| ListingDate | The date this was listed. | Date | 10 | YYYY-MM-DD | n/a | N | N | Y |
| ListingGUID | The unique ID generated by Profit Power for this record. ONLY accessed on GETs | GUID | 36 | n/a | n/a | n/a | n/a | n/a |
| ListingNo | The Profit Power simplified and friendly ID for displaying on the UI. ONLY accessed on GETs | String | 8 | n/a | n/a | n/a | n/a | n/a |
| ListingStatus | The status of this listing | String | 25 | Active | n/a | Y | N | N |
| ListingSource | The source of this listing | String | 30 | Our Website | n/a | N | N | Y |
| ListingThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. | String | 255 | L-5555 | n/a | Y | Y | N |
| ListingType | The type of listing | String | 20 | New | n/a | N | N | Y |
| MLSID | The MLS number of the listing. | String | 100 | B001192 | n/a | N | N | Y |
| MLSRemarks | The MLS comments of this listing | String | 30 | A great starter home. | n/a | N | N | Y |
| Municipality | The municipality. | String | 100 | n/a | n/a | N | N | Y |
| Neighborhood | The neighborhood. | String | 100 | Southworns | n/a | N | N | Y |
| OfficeListingFlag | This identifies if this listing is an office listing. Is this your company listing. | Integer | 0 or 1 | 1 | n/a | Y | N | N |
| OfficeThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. OfficeThirdPartyID is required when OfficeListingFlag = 1. | String | 255 | n/a | n/a | Y | N | N |
| Paging | Refer to Paging definition on this page. ONLY accessed on GETs | Object | n/a | n/a | n/a | n/a | n/a | n/a |
| PropertySqFt | Property square footage of this listing. | Integer | 4 | 3500 | 0-9999 | N | N | Y |
| PropertyType | The property type of this listing | String | 20 | Residential | n/a | N | N | Y |
| PropertyType2 | The secondary property type of this listing | String | 25 | Single Family | n/a | N | N | Y |
| Seller1Client | Client information for this seller. Refer to Client definition on this page. |
Object | n/a | n/a | n/a | n/a | n/a | n/a |
| Seller2Client | Client information for this seller. Refer to Client definition on this page. |
Object | n/a | n/a | n/a | n/a | n/a | n/a |
| State | The state of the address. | String | 15 | NY | n/a | N | N | Y |
| StreetDirection | The street direction of the address. | String | 15 | South | n/a | N | N | Y |
| StreetName | The street name of the address. | String | 100 | Main St | n/a | Y | N | Y |
| StreetNumber | The street number of the address. | String | 100 | 123 | n/a | N | N | Y |
| StreetType | The street type of the address. | String | 15 | Ave | n/a | N | N | Y |
| TotalBedrooms | The total bedrooms on the listing | String | 3 | 4 | n/a | N | N | Y |
| TotalBaths | The total baths on the listing. | Integer | 2 | n/a | 0-99 | N | N | Y |
| UnitNumber | The unit number of the address. | String | 100 | Apt 3B | n/a | N | N | Y |
| UpdatedBy | The account that updated the record in Profit Power. ONLY accessed on GETs | String | 40 | n/a | n/a | n/a | n/a | n/a |
| YearBuilt | Year this listing was built. | Integer | 4 | 1991 | 1200-3000 | N | N | Y |
| ZipCode | The zip of the address. | String | 10 | 14224 | n/a | N | N | Y |
Look Up
Look up data is the data shown in dropdown boxes and areas where different options can be selected.
Below are accepted values passed into the Title to retrive its look up data.
| Title | Title | Title | Title | |||
|---|---|---|---|---|---|---|
| AcctSegTypes | DealClass | MailMaterial | ReloSubSource | |||
| Action_Type | District | MarketArea | ResidenceType | |||
| Activity | Downpayments | MiddleSchoolName | RoleType | |||
| ActivityStatus | ElemementarySchoolName | Month | SaleCondition | |||
| AdditionalIncomeType | EMailEvents | Municipality | SaleReportingCode | |||
| AdType | EntityType | Newspaper | SaleType | |||
| AgencyType | EscrowCheckType | NonCommIncome | Salutations | |||
| Architecture | ExpenseDescription | NoteType | SortCode | |||
| Banner | ExpenseQualification | OfficeType | StateProv | |||
| BasementType | ExpenseStatusType | OffTheBottom | StreetName | |||
| BodyWater | ExpenseTypes | OffTheTop | StreetSide | |||
| BPType | FinancingType | OptionTitle | StreetType | |||
| BrokerType | Fireplace | Park | TenureStatus | |||
| BuildingType | Group | ParkingType | Titles | |||
| BusinessCategory | HeatingType | PartnerType | WeekdayName | |||
| BusLegalForms | HelpCategory | PriceCategory | WorkStatus | |||
| Category | HelpType | PropertyType | Zoning | |||
| CommissionType | HighSchoolName | PropertyType2 | ||||
| CommPlanRole | InsuranceType | PropUse | ||||
| ConstructionType | JobTitle | Publication | ||||
| ContactNoteType | LeaseType | QualificationType | ||||
| ContactType | ListingSource | Rating | ||||
| Country | ListingStatus | ReasonForFailure | ||||
| County | ListingStyle | ReferralType | ||||
| Currency | ListType | Register |
Misc Sale
| Title | Description | Type | Length | Format | Range | Required? | Unique? | Accept Null |
|---|---|---|---|---|---|---|---|---|
| ClosingRemarks | Accounting closing comments | String | 8000 | n/a | n/a | N | N | Y |
| Commissions | Commissions on this sale. Refer to Commissions definition on this page. |
Object | n/a | n/a | n/a | n/a | n/a | n/a |
| CommissionType | Type of commission | String | 30 | Sale | n/a | N | N | Y |
| CreatedBy | The account that created the record in Profit Power. ONLY accessed on GETs | String | 50 | n/a | n/a | n/a | n/a | n/a |
| DateEntered | The date the record was create in Profit Power. JSON dates have the same format as the ISO-8601 standard ONLY accessed on GETs |
DateTime | 24 | YYYY-MM-DDTHH:mm:ss.sssZ | n/a | n/a | n/a | n/a |
| DateUpdated | The date the record was updated in Profit Power. JSON dates have the same format as the ISO-8601 standard ONLY accessed on GETs |
DateTime | 24 | YYYY-MM-DDTHH:mm:ss.sssZ | n/a | n/a | n/a | n/a |
| ListGCIRate | GCI Rate for the listing side | Decimal | 6 | 0.025 | 0-1 | N | N | Y |
| OfficeThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. | String | 255 | SO-1234 | n/a | Y | Y | N |
| Paging | Refer to Paging definition on this page. ONLY accessed on GETs | Object | n/a | n/a | n/a | n/a | n/a | n/a |
| ReferenceNote | The equivalent to the property address. | String | 70 | Outgoing Referral - 123 Main St | n/a | N | N | Y |
| ReportingCode | Used for reporting purposes. | String | 50 | n/a | n/a | N | N | Y |
| SaleComments | Comments about the sale. | String | 8000 | This will close fast. | n/a | N | N | Y |
| SaleGUID | The unique ID generated by Profit Power for this record. ONLY accessed on GETs | GUID | 36 | n/a | n/a | n/a | n/a | n/a |
| SaleNo | The Profit Power simplified and friendly ID for displaying on the UI. ONLY accessed on GETs | String | 8 | n/a | n/a | n/a | n/a | n/a |
| SalePrice | Pice of the sale on the property. | Decimal | 10 | 15423.76 | 0-9999999 | N | N | Y |
| SaleSource | Where the sale came from | String | 30 | Website | n/a | N | N | Y |
| SellGCIRate | GCI rate for the selling side | Decimal | 6 | 0.025 | 0-1 | N | N | Y |
| UpdatedBy | The account that updated the record in Profit Power. ONLY accessed on GETs | String | 40 | n/a | n/a | n/a | n/a | n/a |
Paging
This is used when accessing endpoing that require paging. You must specify the page number you are calling.
| Title | Description | Type | Length | Format | Range | Required? | Unique? | Accept Null |
|---|---|---|---|---|---|---|---|---|
| PageCount | The amount of pages available. | Integer | 6 | 100 | n/a | n/a | n/a | n/a |
| PageNo | The current page the recordset | Integer | 6 | 3 | 1-99999 | Y | N | N |
| PageSize | The amount of records returned per page. This amount can be different per endpoint. | Integer | 6 | 100 | n/a | n/a | n/a | n/a |
| TotalRecordCount | The total number of records available | Integer | 6 | 22365 | n/a | n/a | n/a | n/a |
Sale
| Title | Description | Type | Length | Format | Range | Required? | Unique? | Accept Null |
|---|---|---|---|---|---|---|---|---|
| AcceptanceDate | The date the record was updated in Profit Power. JSON dates have the same format as the ISO-8601 standard |
DateTime | 24 | YYYY-MM-DDTHH:mm:ss.sssZ | n/a | n/a | n/a | n/a |
| AlternateGrossRate | Gross rate that is not standard | Decimal | 6 | 0.025 | 0-1 | N | N | Y |
| ATRNumber | Can be used as a tracking number | Integer | n/a | n/a | 0-999999 | N | N | Y |
| BrokerReferral1Amount | Amount going to this referral | Decimal | 10 | 1423.76 | 0-9999999 | N | N | Y |
| BrokerReferral1Percent | Percentage going to the referral | Decimal | 6 | 0.5 | 0-1 | N | N | Y |
| BrokerReferral1Side | Listing or Selling, ONLY required if there is a BrokerReferralThirdPartyID entered. | String | 10 | n/a | n/a | N | N | Y |
| BrokerReferralThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. | String | 255 | BR-0101 | n/a | Y | Y | N |
| BrokerReferral2Amount | Amount going to this referral | Decimal | 10 | 1423.76 | 0-9999999 | N | N | Y |
| BrokerReferral2Percent | Percentage going to the referral | Decimal | 6 | 0.5 | 0-1 | N | N | Y |
| BrokerReferral2Side | Listing or Selling, ONLY required if there is a BrokerReferral2ThirdPartyID entered. | String | 10 | n/a | n/a | N | N | Y |
| BrokerReferral2ThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. | String | 255 | BR-0102 | n/a | Y | Y | N |
| Buyer1Client | Client information for this buyer. Refer to Client definition on this page. |
Object | n/a | n/a | n/a | n/a | n/a | n/a |
| Buyer2Client | Client information for this buyer. Refer to Client definition on this page. |
Object | n/a | n/a | n/a | n/a | n/a | n/a |
| ClosingRemarks | Accounting closing comments | String | 8000 | n/a | n/a | N | N | Y |
| CommissionPlanCode | The value that represents the commission plan stored in the Profit Power System | Intger | 6 | 253 | 0-999999 | N | N | Y |
| Commissions | Commissions on this sale. Refer to Commissions definition on this page. |
Object | n/a | n/a | n/a | n/a | n/a | n/a |
| CommissionType | Type of commission | String | 30 | Sale | n/a | N | N | Y |
| CreatedBy | The account that created the record in Profit Power. ONLY accessed on GETs | String | 50 | n/a | n/a | n/a | n/a | n/a |
| DateEntered | The date the record was create in Profit Power. JSON dates have the same format as the ISO-8601 standard ONLY accessed on GETs |
DateTime | 24 | YYYY-MM-DDTHH:mm:ss.sssZ | n/a | n/a | n/a | n/a |
| DateUpdated | The date the record was updated in Profit Power. JSON dates have the same format as the ISO-8601 standard ONLY accessed on GETs |
DateTime | 24 | YYYY-MM-DDTHH:mm:ss.sssZ | n/a | n/a | n/a | n/a |
| EstimatedCloseDate | The estimated closing date. | Date | 10 | YYYY-MM-DD | n/a | N | N | Y |
| IsNonstandardCommPlan | The flag that identifies the commission plan a being standard in Profit Power. 0 = Standard, 1 = Non Standard | Integer | 0 or 1 | 1 | 0-1 | Y | N | N |
| Listing | Listing on this sale. Refer to Listing definition on this page. |
Object | n/a | n/a | n/a | n/a | n/a | n/a |
| MortgageAmount | Amount of the mortgage | Decimal | 15 | 453774.37 | 0-99999999 | N | N | Y |
| OfficeThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. | String | 255 | SO-1234 | n/a | Y | Y | N |
| OutsideBrokerIDThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. | String | 255 | OB-002 | n/a | Y | Y | N |
| Paging | Refer to Paging definition on this page. ONLY accessed on GETs | Object | n/a | n/a | n/a | n/a | n/a | n/a |
| PostPeriod | Written business reporting / contract taken date. | Date | 10 | YYYY-MM-DD | n/a | n/a | n/a | n/a |
| ReportingCode | Used for reporting purposes. | String | 50 | n/a | n/a | N | N | Y |
| SaleComments | Comments about the sale. | String | 8000 | This will close fast. | n/a | N | N | Y |
| SaleGUID | The unique ID generated by Profit Power for this record. ONLY accessed on GETs | GUID | 36 | n/a | n/a | n/a | n/a | n/a |
| SaleNo | The Profit Power simplified and friendly ID for displaying on the UI. ONLY accessed on GETs | String | 8 | n/a | n/a | n/a | n/a | n/a |
| SalePrice | Pice of the sale on the property. | Decimal | 10 | 15423.76 | 0-9999999 | N | N | Y |
| SaleSource | Where the sale came from | String | 30 | Website | n/a | N | N | Y |
| SaleThirdPartyID | The ID referencing the record given by the company who POSTed (added) this to the Profit Power System. | String | 255 | S-9999 | n/a | Y | Y | N |
| SaleType | The type of sale this is in relation to the Profit Power System.
IH = "Our List and Sale" OL = "Our List O/B Sale" OS = "O/B list Our Sale" |
String | 50 | OH | n/a | Y | N | N |
| StageNumber | Open field used for any value | String | 6 | n/a | 333444 | N | N | Y |
| TitleCompanyReferenceNo | Reference number to the title company | String | 20 | TC-232 | n/a | N | N | Y |
| UpdatedBy | The account that updated the record in Profit Power. ONLY accessed on GETs | String | 40 | n/a | n/a | n/a | n/a | n/a |
SSO
This will return a unique key that is valid for 5 minutes. After that time the key will expire and the link for SSO will no longer be valid. We recomend you call this SSO at the time the user clicks the link, get the value returned, and then redirect them to the SSO page.
After getting the SSO key you will redirect the user. https://***Your PP Host Header***.profitpowerweb.com/5s0nen.aspx?v=3&p=***Your New SSO Key***
| Title | Description | Type | Length | Format | Range | Required? | Unique? | Accept Null |
|---|---|---|---|---|---|---|---|---|
| CompanyNo | Company Number in PP being searched | Integer | 3 | 001 | n/a | Y | n/a | N |
| FieldToLookUp | This is a 2 character representation of the field in PP database that we are looking at for this login. LN = "Lisense_Number" AN = "AssociateNo" AI = "Associate_ID" AU = "Assocaite_Username" |
String | 2 | LN | n/a | Y | n/a | N |
| LookUpValue | This is the value your system is passing Profit Power to compare for the auto login. Based on FieldToLookUp |
Integer | 20 | 21908321 | n/a | Y | n/a | N |
| StartAtLeftOrRight | This represents the side (L or R) we are counting from to get value to compare. | String | 1 | L or R | n/a | Y | n/a | N |
| TotalCharactersToSearch | This is how many characters we are counting starting from the side you specified in "StartAtLeftOrRight". Enter 0 (zero) if you want all characters. | Integer | 2 | 0 | 0-20 | Y | n/a | N |